rrweb docs

English

简体中文

English

简体中文

Get recording player​

GET
/recordings/{recordingId}/player

Serves the recording player HTML page. Request /recordings/{recordingId}/player.html or send Accept: text/html for the HTML representation. File extensions take precedence over the Accept header when both are present.

Authorizations

Private API Key
Private API Key
Bearer token for authentication. Use your private API key as the token.
or
Presigned URL
Presigned URL
Use a presigned URL generated by the List Recordings endpoint with includeSignedUrls=true. Time-constrained and scoped to a single recording, so it can be exposed publicly in your replayer.
Show parameters: TenantId, KeyId, Expires, Signature
TenantId
Your tenant (organisation) identifier. Included automatically in presigned URLs generated by the listing endpoints.
KeyId
The name/label of the signing key configured in your rrweb Cloud account. e.g. "key-2024-12"
Expires
Expiration timestamp (UNIX seconds)
Signature
SHA256 over the constructed string "GET /recordings/{recordingId} {tenantId} {expires}". Please get in contact if you need to calculate this manually.

Parameters​

Path Parameters

recordingId*

The recording ID

Type
string
Required
Example"000e8400-e00b-00d0-a716-446655440000"
Format
"uuid"

Query Parameters

controls

Show the control bar (default: true).

Type
string
Example"true"
autoplay

Autoplay on load (default: false).

Type
string
Example"false"
mode

Player display mode. standard renders the full player page, minimal strips surrounding chrome for embeds, and capture uses the full-viewport layout optimized for screenshots.

Type
string
Example"standard"
speed

Playback speed from 0.25 to 4 (default: 1). Values outside this range return 400.

Type
string
Example"1"
time

Playback position selector. Supports offset, percent, and epoch formats: offset:5000, offset:-5000, percent:50, or epoch:1702900000000. Defaults to offset:0.

Type
string
Example"offset:0"
eventsUrl

Optional same-origin or relative events URL override. Used internally with presigned event URLs for player and screenshot rendering.

Type
string
Example"https://api.example.com/recordings/000e8400-e00b-00d0-a716-446655440000/events?tenantId=tenant-123&expires=1700000000&keyId=key-2025-12&signature=abcdef"

Responses​

Recording player HTML page

text/html
JSON
"<!doctype html>"

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI